CreateOrUpdate Merchant
Operation to CreateOrUpdate (create or update) a merchant and define the merchant's general details.
Authentication
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
Basic HTTP authentication as described at
w3.org.
Provide 'MSO.
<your gateway MSO ID>' in the userid portion and your API password in the password portion.
Request
URL Parameters
Alphanumeric + additional characters
REQUIRED
The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
Min length: 1 Max length: 16Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length: 1 Max length: 36Fields
String
= CREATE_OR_UPDATE_MERCHANT
FIXED
Any sequence of zero or more unicode characters.
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
The merchant's general details.
Use this parameter group to configure what types of account funding transactions the merchant is allowed to submit for processing.
Account funding transactions are transactions that pull money from an account (the sender's account) for the purpose of crediting another account (the recipient's account). The fields in this parameter group must be provided if you have enabled the merchant for account funding transactions, i.e. the request contains merchant.service[n]=ENABLE_ACCOUNT_FUNDING.
Enumeration
REQUIRED
Defines for which purpose the merchant will be allowed to submit account funding transactions.
Value must be a member of the following list. The values are case sensitive.
CRYPTOCURRENCY_PURCHASE
Allows account funding transactions where the funds will be used to purchase cryptocurrency.
MERCHANT_SETTLEMENT
Allows account funding transactions where the funds will be used to settle the proceeds of processing card transactions.
OTHER
Allows account funding transactions where the funds will be used for any other purpose, e.g. transferring funds from a person to a person or transferring funds into a staged wallet.
PAYROLL
Allows account funding transactions where the funds will be used to pay salaries.
Enumeration
REQUIRED
Defines for which recipient account funding methods the merchant will be allowed to submit account funding transactions.
Value must be a member of the following list. The values are case sensitive.
CHARGE
Allows account funding transactions where the card associated with the recipient's bank account is a Charge card.
CREDIT
Allows account funding transactions where the card associated with the recipient's bank account is a Credit card.
DEBIT
Allows account funding transactions where the card associated with the recipient's bank account is a Debit card.
UNKNOWN
Allows account funding transactions where the card associated with the recipient's bank account is any other than Credit, Debit or Charge card.
Enumeration
REQUIRED
Defines for which recipient account types the merchant will be allowed to submit account funding transactions.
Value must be a member of the following list. The values are case sensitive.
CARD_ACCOUNT
Allows account funding transactions where the recipient account is an account associated with a card, e.g. a Debit or Credit card.
OTHER
Allows account funding transactions where the recipient account is neither an account associated with a card nor a staged wallet.
STAGED_WALLET
Allows account funding transactions where the recipient account is a staged wallet.
STORED_VALUE_WALLET
Allows account funding transactions where the recipient account is a stored value wallet.
Enumeration
REQUIRED
Defines if the merchant will be allowed to submit account funding transactions where the sender and recipient are different, the same or both.
Value must be a member of the following list. The values are case sensitive.
SENDER_DIFFERS_FROM_RECIPIENT
Allows account funding transactions where the sender is different to the recipient.
SENDER_MATCHES_RECIPIENT
Allows account funding transactions where the sender and recipient are the same.
Enumeration
REQUIRED
Defines if the merchant will be allowed to submit account funding transactions where the sender account is owned by an entity of this type.
The sender account refers to the account from which money is being pulled.
Value must be a member of the following list. The values are case sensitive.
COMMERCIAL_ORGANIZATION
Allows account funding transactions where the sender is a commercial organization.
GOVERNMENT
Allows account funding transactions where the sender is a government.
NON_PROFIT_ORGANIZATION
Allows account funding transactions where the sender is a non profit organization.
PERSON
Allows account funding transactions where the sender is a person.
Use this parameter group to enable and configure a merchant for the Account Updater functionality for American Express cards using American Express Cardrefresher.
Account Updater functionality ensures that, when the merchant submits stored card details on a transaction request, the gateway automatically checks with the specific scheme's Account Updater service that the details are up-to-date before using them for transaction processing. To be able to use the Account Updater functionality the merchant must be enabled for gateway tokenization and the token repository assigned to the merchant must be enabled for Token Management = 'Unique Account Identifier' and Token ID = ' Random With Luhn' or 'Merchant Supplied'.
Digits
OPTIONAL
The 10-digit Merchant ID assigned to the merchant by American Express when the merchant was onboarded for Cardrefresher.
This matches the American Express Service Establishment Number (SE Number). If the field is provided, Account Updater functionality for American Express cards will be enabled for this merchant.
Data is a string that consists of the characters 0-9.
Enumeration
OPTIONAL
The authentication mode used by the merchant to authenticate to the payment gateway
Value must be a member of the following list. The values are case sensitive.
usePasswordAuthentication
Allows the merchant to use passwords to authenticate to the payment gateway.
useSSLCertificateAuthentication
Allows the merchant to use SSL certificates to authenticate to the payment gateway.
rollYourAuthenticationMode
Allows the merchant to change authentication modes (password to SSL certificate or vice versa) by using an intermediate setting that supports both old and new authentication modes. Once your integration is ready to go live with the new authentication mode, the authentication mode on this page must be set to the new one.
Use this parameter group to enable and configure a merchant for payer authentication using 3-D Secure authentication version 1 (3DS1) and 3-D Secure authentication version 2 (3DS2).
Details about the merchant's configuration for payer authentication using 3-D Secure authentication version 2 (3DS2).
Details about the FAST'R by CB configuration for the merchant.
FAST'R by CB allows the merchant to perform payer authentication for Carte Bancaire cards.
Alphanumeric
OPTIONAL
A unique identifier for the merchant used when authenticating a payer making a payment using a Carte Bancaire card.
Provide the SIRET number issued to the merchant by INSEE.
Data may consist of the characters 0-9, a-z, A-Z
Integer
OPTIONAL
Number of days after authorization in which a capture is valid
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Enumeration
REQUIRED
The card number masking format applied by the gateway when the merchant supplied the card number.
This format will be used for transactions originating from Web Services API and Merchant Administration.
Formats for masking card numbers.
Value must be a member of the following list. The values are case sensitive.
DISPLAY_0_4
Display last 4 digits of Card Number.
DISPLAY_6_3
Display first 6 and last 3 digits of Card Number.
DISPLAY_6_4
Display first 6 and last 4 digits of Card Number.
DISPLAY_FULL
Display Full Card Number.
DISPLAY_NONE
Display No Card Number.
String
OPTIONAL
The Certificate Set ID is a unique identifier that you have assigned to uniquely identify a merchant's test and production SSL certificates.
Provide this field if the merchant will use SSL certificates to authenticate to the gateway when using the API. If not provided, the merchant will be enabled for Password Authentication.
If your customer has multiple gateway merchant profiles, then they can share the same Certificate Set. In this case, provide the same Certificate Set ID for each of their gateway merchant profiles.
You can create Certificate Sets for your merchants from the Merchant Manager UI.
Data can consist of any characters
Configuration details to enable the Dynamic Currency Conversion (DCC) service.
DCC enables merchants to accept payments from payers in their currency, which can differ from the merchant's currency for the order.
Upper case alphabetic text
OPTIONAL
The base currency registered for the merchant ID at the DCC provider.
The value must be expressed as an ISO 4217 alpha code.
Data must consist of the characters A-Z
Alpha
OPTIONAL
The identifier for the acquirer the merchant has registered with the DCC provider.
Data may consist of the characters a-z, A-Z
Enumeration
REQUIRED
DCC rate quote providers.
Value must be a member of the following list. The values are case sensitive.
FEXCO
FEXCO DCC provider.
FTT
FTT Global DCC provider.
GLOBAL_PAYMENTS
GLOBAL_PAYMENTS DCC provider.
IBM
IBM DCC provider.
TRAVELEX_CURRENCY_SELECT
Travelex DCC provider.
UNICREDIT
UNICREDIT DCC provider.
Alphanumeric
OPTIONAL
The unique identifier for the merchant account at the DCC provider.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
REQUIRED
The currency conversion rate that will apply to a refund transaction executed against an exiting order.
The currency conversion rate that will apply to a refund transaction executed against an existing order.
Value must be a member of the following list. The values are case sensitive.
CURRENT
A new rate quote is being requested to provide the actual rate at the refund transaction date.
HISTORICAL
The rate used when the order was created.
Enumeration
REQUIRED
Specifies the Visa disclosure region for the merchant.
This determines the Dynamic Currency Conversion offer and receipt texts presented to the payer.
Value must be a member of the following list. The values are case sensitive.
EUROPE
The Visa disclosure rules for Europe
INTERNATIONAL
The Visa disclosure rules for the International region
Use this parameter group to enable and configure a merchant for debt repayments.
Enumeration
OPTIONAL
To enable the merchant for debt repayments you must provide at least one funding method for which debt repayments are allowed.
When submitting a debt repayment the merchant must indicate on the transaction request that it is for a debt repayment and may have to provide additional information about the payment recipient. Where the gateway is unable to detect the funding method (UNKNOWN) for a transactions request, the gateway will always reject the transaction if it is a debt repayment.
Value must be a member of the following list. The values are case sensitive.
CREDIT
Debt transactions can be processed using Credit Card.
DEBIT
Debt transactions can be processed using Debit Card.
CHARGE
Debt transactions can be processed using Charge Card.
Enumeration
OPTIONAL
Sets the default value used for order certainty when the merchant does not provide a value on the API request.If you do not specify this value it will be set to FINAL.
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
Merchant's orders will be assumed to have an order certainty of ESTIMATED where none is specified in WS-API requests.
FINAL
Merchant's orders will be assumed to have an order certainty of FINAL where none is specified in WS-API requests.
String
OPTIONAL
Only provide this field if you have received a notification from the scheme that the merchant has a high number of disputes.
In this case, provide a phone number that payers can use to contact the merchant in case of a dispute. Where applicable, the issuer may display this phone number on the cardholder statement.
The phone number must be provided in ITU-T E123 format.
Data can consist of any characters
Integer
OPTIONAL
Maximum number of rows you wish to download in the Payment Authentications file..
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
OPTIONAL
Defines the excess amount permitted to be captured on the original authorized amount, as a percentage.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Details regarding the merchant's MasterPass Online configuration.
Alphanumeric
REQUIRED
A unique identifier for the merchant in the MasterPass Online system, issued by MasterPass Online when boarding the merchant.
Data may consist of the characters 0-9, a-z, A-Z
Boolean
OPTIONAL
If enabled, the payer's shipping address is collected at MasterPass Online and returned to the merchant in the transaction response
JSON boolean values 'true' or 'false'.
String
OPTIONAL
The consumer key value as issued by Masterpass for the merchant's production profile.
Data can consist of any characters
String
OPTIONAL
The consumer key value as issued by Masterpass for the merchant's sandbox profile.
Data can consist of any characters
Alphanumeric
OPTIONAL
The shipping location defines which countries the merchant ships to and restricts the customer's shipping address selection in MasterPass Online accordingly.
If provided, this shipping location applies for all MasterPass Online transactions. If not provided, MasterPass Online uses the preferred shipping profile configured against the merchant's MasterPass Online profile.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding the merchant's risk configuration.
Enumeration
OPTIONAL
Allows you to define when the gateway should send the merchant's transactions to the risk service provider for risk assessment.
Value must be a member of the following list. The values are case sensitive.
AFTER_TRANSACTION_PROCESSING
Transactions will be submitted to the risk service provider after they have been submitted to the acquirer for processing. AVS, CSC and other available acquirer response data will be included in the request.
BEFORE_AND_AFTER_TRANSACTION_PROCESSING
Transactions will be submitted to the risk service provider both before and after they have been submitted to the acquirer for processing. AVS, CSC and other acquirer response data will only be available to be included in the second request.
BEFORE_TRANSACTION_PROCESSING
Transactions will be submitted to the risk service provider before they have been submitted to the acquirer for processing. No acquirer response data will be available to be included in the request. Please note that selecting "Before transaction processing" and "May Use Verification Only for AVS/CSC Risk Assessment" is not a valid configuration option.
Enumeration
OPTIONAL
The risk assessment status for the risk service provider.
Value must be a member of the following list. The values are case sensitive.
TEST_AND_PRODUCTION
Both, transactions submitted using a Production merchant profile and transaction submitted using a TEST merchant profile will be risk assessed by the risk service provider.
TEST_ONLY
Only transaction submitted using a TEST merchant profile will be assessed by the risk service provider.
Configuration details for the GateKeeper risk service provider profile
Credentials for the merchant's production profile used to access the GateKeeper scoring module.
String
OPTIONAL
The GateKeeper merchant ID used to identify the GateKeeper profile linked to this merchant profile.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates if the gateway should submit the merchant ID for the merchant's gateway profile to Gatekeeper when submitting transactions for risk assessment.
If selected, this will apply to all gateway merchant profiles configured to use this Gatekeeper profile.
Value must be a member of the following list. The values are case sensitive.
DO_NOT_SEND
Do not send the merchant ID for the merchant's gateway profile to Gatekeeper when submitting transactions for risk assessment.
SEND
Send the merchant ID for the merchant's gateway profile to Gatekeeper when submitting transactions for risk assessment.
Enumeration
OPTIONAL
The service level offering that the Merchant has signed up to with GateKeeper.
Value must be a member of the following list. The values are case sensitive.
GOLD
The Gold service level.
Credentials for the merchant's test profile used to access the GateKeeper scoring module.
String
OPTIONAL
The GateKeeper merchant ID used to identify the GateKeeper profile linked to this merchant profile.
Data can consist of any characters
Configuration details for the Interceptas risk service provider profile
Email
OPTIONAL
The Interceptas tenant's billing contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
REQUIRED
The Interceptas tenant's billing contact name.
Data can consist of any characters
String
OPTIONAL
The Interceptas tenant's billing contact phone.
Data can consist of any characters
Email
OPTIONAL
The Interceptas tenant's business contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The Interceptas tenant's business contact name.
Data can consist of any characters
String
OPTIONAL
The Interceptas tenant's business contact phone.
Data can consist of any characters
Enumeration
OPTIONAL
This identifies the type of business that your Merchant is in and influences the risk assessment that will be performed by Interceptas.
Value must be a member of the following list. The values are case sensitive.
AIRLINE_TRAVEL_AGENT
Airline/Travel Agent.
RETAILER_OF_DIGITAL_GOODS
Retailer of digital goods.
RETAILER_OF_PHYSICAL_GOODS
Retailer of physical goods.
Upper case alphabetic text
OPTIONAL
Currency is used by Interceptas to define the risk rules (e.g. average order size).
Any transactions submitted to Interceptas using a different currency will be converted to the corresponding value in the base currency before being risk assessed. The value must be expressed as an ISO 4217 alpha code.
Data must consist of the characters A-Z
String
OPTIONAL
The default language which will be used when users sign into Interceptas.
The value must be provided in the format '<Language>_<Country>', e.g. 'en_US'. <Language> must be a two-letter language code according to ISO 639-1. <Country> must be a two-letter country code according to ISO 3166-1 alpha-2.
Data can consist of any characters
Credentials for the merchant's production profile used to access the Interceptas scoring module.
String
OPTIONAL
The password used to authenticate this merchant profile on the Interceptas scoring module.
Data can consist of any characters
Url
OPTIONAL
The Interceptas URL to which the payment gateway sends the risk scoring request.
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
The tenant ID used to identify the Interceptas tenant linked to this merchant profile.
Data can consist of any characters
String
OPTIONAL
The user name used to identify this merchant profile on the Interceptas scoring module.
Data can consist of any characters
Enumeration
OPTIONAL
The service level offering that the Merchant has signed up to with Accertify.
Value must be a member of the following list. The values are case sensitive.
BRONZE
The Bronze service level.
GOLD
The Gold service level.
SILVER
The Silver service level.
Email
OPTIONAL
The Interceptas tenant's technical contact email.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
REQUIRED
The Interceptas tenant's technical contact name.
Data can consist of any characters
String
OPTIONAL
The Interceptas tenant's technical contact phone.
Data can consist of any characters
Credentials for the merchant's test profile used to access the Interceptas scoring module.
String
OPTIONAL
The password used to authenticate this merchant profile on the Interceptas scoring module.
Data can consist of any characters
Url
OPTIONAL
The Interceptas URL to which the payment gateway sends the risk scoring request.
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
The tenant ID used to identify the Interceptas tenant linked to this merchant profile.
Data can consist of any characters
String
OPTIONAL
The user name used to identify this merchant profile on the Interceptas scoring module.
Data can consist of any characters
String
OPTIONAL
The default timezone which will be used when users sign into Interceptas.
The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of timezones please refer to http://twiki.org/cgi-bin/xtra/tzdatepick.html.
Data can consist of any characters
Enumeration
OPTIONAL
Risk management privileges assigned to the merchant.
Value must be a member of the following list. The values are case sensitive.
RISK_VERIFY_ONLY
Allows the gateway to submit a Verification Only transaction to the acquirer to obtain the AVS and CSC results for use in risk assessment. This avoids having to perform the financial transaction before risk assessment and the need to release the hold on cardholder funds in the event the transaction is rejected due to risk assessment.
SYSTEM_REFUND
Allows the gateway to refund against an order if risk assessment rejects the order after the financial transaction has successfully been performed. This privilege is required only, if the Refunds privilege is not enabled.
Configuration details for the risk service provider profile to be assigned to the merchant for the risk service provider defined in field merchant.merchantManagedRiskAssessment.providerId.
You can only assign an existing risk service provider profile or create a new risk service provider profile. Use Merchant Manager update existing risk service provider profiles.
String
OPTIONAL
Unique identifier for the merchant issued and provided by the risk service provider.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates the action to be taken when the gateway did not receive the risk assessment response from the Risk Service Provider for example, due to connectivity issues.
Value must be a member of the following list. The values are case sensitive.
ACCEPT_NOT_CHECKED
The gateway allows the transaction to progress without the risk assessment being performed. The risk recommendation for the transaction will be set to "Not Checked".
REVIEW
The gateway will require the transaction to be reviewed by the merchant before allowing it to progress. The risk recommendation for the transaction will be set to "Review Required".
String
OPTIONAL
Provide the unique identifier for the risk service provider profile (for the Risk Service Provider identified in field merchant.merchantManagedRiskAssessment.providerId) that you want to assign to the merchant.You can only assign an existing risk service provider profile or create a new risk service provider profile.
When creating a new risk service provider profile you must provide the configuration details for this profile. Use Merchant Manager update existing risk service provider profiles.
Data can consist of any characters
Enumeration
OPTIONAL
Allows you to define if the risk profile can be shared across multiple gateway merchant profiles.Where a merchant has multiple merchant profiles in the gateway, using the same risk profile minimizes risk management overhead. However, if the merchant profiles have significantly different business models such as different typical order values or customer purchase patterns, you may want to set up different risk profiles for the merchant profiles.
Value must be a member of the following list. The values are case sensitive.
MULTIPLE_MERCHANT_PROFILES
The risk profile can be assigned to multiple gateway merchant profiles.
SINGLE_MERCHANT_PROFILE
The risk profile can only be assigned to a single gateway merchant profile.
String
OPTIONAL
The unique identifier issued by the gateway for the risk service provider for which you want to create or assign a profile for the merchant.Please contact your Payment Services Provider for a list of supported risk service providers.
Data can consist of any characters
Details for the Merchant Monitoring functionality.
The Merchant Monitoring functionality ensures that your merchants' transactions are submitted to the Risk Service Provider for risk merchant monitoring.
Only provide the fields in this parameter group if you want to override the standard configuration for the Merchant Monitoring functionality that you have configured in Merchant Manager on the Merchant Monitoring page.
To apply the standard configuration to the merchant, do not include this parameter group.
Enumeration
OPTIONAL
Indicates whether the standard configuration for the Merchant Monitoring functionality you have configured in Merchant Manager on the 'Risk - Merchant Monitoring' page applies to the merchant or if you want to override it.
Value must be a member of the following list. The values are case sensitive.
OVERRIDE
The standard configuration does not apply to the merchant. The configuration defined in the merchant.merchantMonitoring.override parameter group applies.
STANDARD
The standard configuration applies to the merchant.
Use this parameter group to provide the configuration for the Merchant Monitoring functionality for this merchant.Only provide this parameter group if you do not want the standard configuration to apply, i.e. have provided merchant.merchantMonitoring.configuration=OVERRIDE in the request.
Enumeration
OPTIONAL
Indicates whether the Merchant Monitoring functionality is enabled or disabled for the merchant.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The Merchant Monitoring functionality is disabled for the merchant.
ENABLED
The Merchant Monitoring functionality is enabled for the merchant.
String
OPTIONAL
The configuration that will be applied to this merchant for the 'Tax and Product Details' section on the Order Entry page in Merchant Administration.
Data can consist of any characters
Details for the Partner-managed Risk Assessment functionality.
The Partner-managed Risk Assessment functionality ensures that the merchant's transactions are submitted to the Risk Service Provider for risk assessment and blocked if they are identified as fraudulent.
Only provide the fields in this parameter group if you want to override the standard configuration for the Partner-managed Risk Assessment functionality that you have configured in Merchant Manager on the Partner-managed Risk Assessment' page.
To apply the standard configuration to the merchant, do not include this parameter group.
Details for the transaction risk assessment functionality.
The transaction risk assessment functionality ensures that the merchant's transactions are submitted to the Risk Service Provider for risk assessment and blocked if they are identified as fraudulent.
Enumeration
OPTIONAL
Indicates whether the standard configuration for the transaction risk assessment functionality you have configured in Merchant Manager on the Partner-managed Risk Assessment' page applies to the merchant or if you want to override it.
The default value is STANDARD.
Value must be a member of the following list. The values are case sensitive.
OVERRIDE
The standard configuration does not apply to the merchant. The configuration defined in the merchant.partnerManagedRiskAssessment.transactionRiskAssessment.override parameter group applies.
STANDARD
The standard configuration applies to the merchant. This is the default value.
Use this parameter group to provide the configuration for the transaction risk assessment functionality for this merchant.
Only provide this parameter group if you do not want the standard configuration to apply, i.e. have provided merchant.partnerManagedRiskAssessment.transactionRiskAssessment.configuration=OVERRIDE in the request.
Enumeration
OPTIONAL
Determines when the gateway should submit the transaction to the Risk Service Provider for risk assessment.
Value must be a member of the following list. The values are case sensitive.
AFTER_TRANSACTION_PROCESSING
Transactions will be submitted to the Risk Service Provider for risk assessment after they have been submitted to the acquirer for processing. You may want to also enable the merchant for using Verification Only (merchant.merchantManagedRiskAssessment.privilege[n]=RISK_VERIFY_ONLY).
BEFORE_AND_AFTER_TRANSACTION_PROCESSING
Transactions will be submitted to the Risk Service Provider for risk assessment both before and after they have been submitted to the acquirer for processing.
BEFORE_TRANSACTION_PROCESSING
Transactions will be submitted to the Risk Service Provider for risk assessment before they are submitted to the acquirer for processing.
Enumeration
OPTIONAL
Indicates whether the transaction risk assessment functionality is enabled or disabled for the merchant.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The transaction risk assessment functionality is disabled for the merchant.
ENABLED
The transaction risk assessment functionality is enabled for the merchant.
Enumeration
OPTIONAL
Defines which privileges are enabled for the merchant.
Privileges listed in the request are enabled for the merchant.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_UPDATER_AMEX
Indicates that the merchant has possibility to use Amex Account Updater
ACCOUNT_UPDATER_MASTERCARD
Indicates that the merchant has possibility to use Mastercard Account Updater
ACCOUNT_UPDATER_VISA
Indicates that the merchant has possibility to use Visa Account Updater
ADDITIONAL_ACCEPTOR_AND_SERVICE_LOCATION_DATA
Enables the merchant to provide additional merchant and/or service location data provided on transaction request or configured in Merchant Profile to the Acquirer.
ALLOW_ACQUIRER_TRACE_ID
Enables the merchant to provide Trace ID in the API request. Trace id is the unique identifier that allows issuer to link related transactions.
ALLOW_LEVEL_2_ORDER_CREATION
Enables the merchant to create level 2 orders, i.e. provide level 2 specific data when creating an order.
AMEX_SAFEKEY_2
May perform 3DS 2.0 American Express SafeKey authentications.
AUTHORIZATIONS
Enables the merchant to perform authorizations.
AUTO_AUTH_REVERSAL_ON_EXPIRY
The gateway will automatically reverse any outstanding Authorization amounts where an Authorization has expired.
AUTO_AUTH_REVERSAL_ON_PARTIAL_CAPTURE
Where the merchant indicates on a Partial Capture transaction that it is the last Capture they are intending to submit against the Authorization, the gateway will automatically reverse the outstanding Authorization amount.
AVS
Allows the merchant to use the Address Verification Service (AVS) to authenticate cardholders during a transaction.
AVS_TRANSACTION_FILTERING_RULES_OVERRIDE
Enables the merchant to submit a transaction request with Transaction Filtering rules for AVS response codes that override the ones configured for all of their transactions.
BULK_CAPTURES
Enables the merchant to perform multiple captures using a single action in Merchant Administration.
BYPASS_AUTHENTICATION_CAPABILITY_VALIDATION
The gateway rejects financial transaction requests with payer authentication data if the acquirer integration does not have support for this data. If you enable this privilege, the gateway will instead process the financial transaction (i.e. ignore the authentication data).
BYPASS_CARD_CHANGE_FOR_AGREEMENT_VALIDATION
The gateway ensures that when the card used for a recurring, installment, unscheduled or other agreement changes, the merchant must submit a customer-initiated payment. Where this privilege is enabled, this validation is not applied for this merchant.
BYPASS_UNUSUAL_TRANSACTION_PROTECTION
The gateway's Unusual Transaction Protection Service helps to protect merchants from processing unusual transactions. If you decide to opt out from the Unusual Transaction Protection Service, this protection will not be applied and the number of unauthorized excessive transactions (and other similar occurrences) processed by the merchant may increase. By opting out of the Unusual Transaction Protection Service, you accept and agree that you are solely responsible for this increased risk, including any increased charges the merchant may incur in relation to the processing of excessive or unusual transactions.
CAPTURES
Enables the merchant to perform captures.
CAPTURE_EXPIRY
May set expiration for captures.
CARD_ON_FILE
Enables the Merchant to indicate whether the card is stored on file by default.
CASH_ADVANCE
Enables the merchant to submit Cash Advance transactions.
CHANGE_MERCHANT_TRANSACTION_SOURCE
Enables the merchant to provide the source of the transaction when creating the transaction. If not enabled or not provided by the merchant, the gateway automatically assigns the default transaction source.
CHANGE_ORDER_CERTAINTY
Enables the merchant to make use of a value of order certainty other than their configured default (see defaultOrderCertainty) by supplying it in WS-API requests or in the Create Order UI.
CHANGE_TRANSACTION_FREQUENCY
Enables the merchant to change the frequency of a transaction. Note: Values set for transaction frequency only apply if the merchant uses version 53 and lower of the API.
CREDIT_CARD_BILL_PAYMENTS
Enables the merchant to submit credit card bill payments that disburse funds to the recipient's credit card account.
DEBIT_ROUTING_FOR_HAYS_TRAVEL_PRIVILEGE
Enable Debit Transaction Routing for Hays Travel.
DEBT_REPAYMENT
Enables merchant to indicate that the payment is a debt repayment.
DINERS_PROTECT_BUY_2
May perform 3DS 2.0 Discover ProtectBuy authentications.
EMV
May perform EMV transactions.
ENABLE_REFUND_REQUESTS
Enables an operator to request approval for a refund transaction. The refund transaction is not submitted to the acquirer.
ENFORCE_CARD_NUMBER_MASKING_FOR_INPUT
Enforces card masking when entering a payer's card number in Merchant Administration.
ENFORCE_GATEWAY_TOKEN_FOR_CARD_STORED_ON_FILE_TRANSACTIONS
Where enabled, the gateway will enforce the use of gateway tokens for all transactions that indicate that stored card details are used.
ENFORCE_REFUNDS_WITHOUT_AUTHORIZATIONS
Where supported by the acquirer, the gateway attempts to submit an Authorization to the issuer before submitting the Refund to the acquirer. When this privilege is enabled, the gateway will not attempt to submit an Authorization for the Refund.
ENFORCE_UNIQUE_MERCHANT_TRANSACTION_REFERENCE
Enforces a unique Merchant Transaction Reference for every transaction submitted by the merchant. Transactions without a unique Merchant Transaction Reference are rejected by the gateway.
ENFORCE_UNIQUE_ORDER_REFERENCE
Enforces a unique Order Reference across all orders submitted by the merchant. Transactions without a uniqueOrder Reference are rejected by the gateway.
EXCESSIVE_CAPTURE
Allows merchant to excessively capture an outstanding Authorization amount for an order.
EXCESSIVE_REFUNDS
Enables the merchant to perform refunds for amounts greater than the authorized amount.
FASTR_BY_CB
May perform 3DS 2.0 Carte Bancaire FASTR_BY_CB authentications.
GAMING_WINNINGS_PAYMENTS
Enables the merchant to submit transactions that disburse gaming winnings to the payer's account.
HIGH_DISPUTE_MERCHANT
High Dispute Merchant.
IDENTITY_CHECK_EXPRESS
Enables a merchant with privileges and configuration enabling them to use EMV 3DS to make use of SCA Delegation functionality, so that they can provide their customers a frictionless authentication process where they have already authenticated the customer using an approved authentication mechanism.
INSTANT_REFUNDS
Where supported by the acquirer, the gateway attempts to submit refunds for processing in near real time so that the money will instantly be available in the payer's account.
ITMX_LSS
Enable merchants for LSS authentication in ITMX network.
ITMX_LSS_EMV_3DS
May perform 3DS 2.0 ITMX authentications.
JAYWAN_SECURENXT
May perform Jaywan SecureNxt EMV 3DS payer authentications.
JSECURE_2
May perform 3DS 2.0 JCB JSecure authentications.
LEVEL2_CPC_4X40
Enable Freeform Charge Description Order Entry Fields.
MADA_SECURE
May perform mada secure EMV 3DS payer authentications.
MANUAL_BATCH_CLOSURE
Enables the merchant to manually trigger settlement for a batch in Merchant Administration or via the 'Close Batch' Web Services API operation.
MASTERCARD_INSTALLMENTS_ENHANCED_AUTHORIZATION_DATA
Enables the merchant to offer issuer Mastercard Installments (MCI) using enhanced authorization data. If enabled the gateway will ask the issuer for available offers. Where offers are available the merchant can then present them to the payer.
MASTERCARD_INSTALLMENT_SP_PRODUCTS_OPTOUT
Indicates that the merchant has opted out of the Mastercard Installment SPS (Payments S) and SPP (Payments P) Products.
MA_DOCUMENTATION_DOWNLOAD
Allows merchant administration documentation download.
MOTO
Enables the merchant to manually create orders in Merchant Administration.
NO_CARDS_SUBMITTED_THROUGH_API_SAQ_A
Support merchant to meet SAQ-A obligation when using merchant user interfaces
NO_CARDS_SUBMITTED_THROUGH_UI_SAQ_A
Support merchant to meet SAQ-A obligation when using merchant user interfaces.
OPTIN_REFUND_CONSENT
Allows the merchant to take explicit refund consent from payer if REFUNDS privilege is enabled to merchant for Open Banking transactions.
ORDER_DOWNLOAD
Enables the merchant to download order level data in CSV format.
PAYPAL_SMART_BUTTON
Allows the merchant to offer PayPal Smart button to payer inorder to make purchase for PayPal transactions.
PROCESS_AUTHORIZATION_AS_PURCHASE
May process Authorizations as Purchase
PSD2_EXEMPTIONS
Enables the merchant to claim an exemption from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area. When enabled the merchant can indicate the type of exemption being claimed when using the Authenticate Payer operation or submitting an Authorize or Pay transaction request.
PURCHASES
Enables the merchant to perform purchases.
REFUNDS
Enables the merchant to create refunds. A refund is the transfer of funds from a merchant to the payer's account.
REFUND_EXPIRY
May set expiration for refunds.
RETURN_FULL_FPAN_FOR_VISA_TRANSIT
If enabled, the gateway will store full FPAN details if returned by the acquirer for device payment transactions for Visa cards.
SECURECODE_2
May perform 3DS 2.0 MasterCard SecureCode authentications.
STANDALONE_CAPTURES
Enables the merchant to perform a capture without first performing an authorization. The merchant must perform the authorization externally, and provide the corresponding authorization code as input to the stand alone capture.
STANDALONE_REFUNDS
Enables the merchant to perform a refund without first creating an order (with a capture or purchase).
STATEMENT_DESCRIPTOR
Enables the merchant to print their contact information on payer's account statements.
SUPPORT_EXTENDED_REFUNDS
Enables the merchant to perform a refund for an extended period up to 24 months.
SURCHARGE_RULES
Enables the merchant to configure rules for calculating surcharge amounts.
TXN_DOWNLOAD
Enables the merchant to download transaction level data in CSV format.
UNIONPAY_3DS
May perform UnionPay 3-D Secure authentications.
UPDATE_AUTHORIZATION
Enables the merchant to update an existing authorization, allowing to update the authorized amount or expand the validity period for the order.
VERIFIED_BY_VISA_2
May perform 3DS 2.0 Verified by Visa authentications.
VIEW_SETTLEMENT_PAGES
Enables the merchant to view batch settlement details in Merchant Administration.
VIEW_UNMASKED_ACCOUNT_IDENTIFIERS
Enables the merchant to allow merchant operators to view unmasked account identifiers in Merchant Administration.
VOIDS
Enables the merchant to void transactions. A void is the cancellation of a previous transaction. Voids can only be performed if the transaction is in an unreconciled batch and if the operation is supported by the acquirer.
Integer
OPTIONAL
Number of days after authorization in which a refund is valid.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Enumeration
OPTIONAL
A gateway feature that you can enable for a merchant.
Use this field to enable a service on this merchant profile.
Note: the options available to you are determined by your gateway configuration and in addition to the rules defined by the merchant themselves.
Value must be a member of the following list. The values are case sensitive.
ENABLE_ACCOUNT_FUNDING
Enables the merchant to submit account funding transactions, i.e. transactions that pull money from an account for the purpose of crediting another account.
ENABLE_AMEX_EXPRESS_CHECKOUT
Enables the merchant to use the Amex Express Checkout digital wallet to collect the payer's payment details.
ENABLE_APPLE_PAY_ON_HOSTED_CHECKOUT
Enables the merchant to use Apple Pay on HCO where decryption is done using gateway managed certificate.
ENABLE_AUTHENTICATION_MANAGED_BY_CLICK_TO_PAY
Enables payer authentication using passkey or EMV 3DS with Click to Pay where available. e.g. Using Mastercard Token Authentication Service TAS.
ENABLE_BATCH
Enables the merchant to integrate with the gateway via the Batch API. The Authentication mode is set to 'Password Authentication'.
ENABLE_CHECKOUT_VIA_MERCHANT_WEBSITE
Enables the merchant to use Hosted Checkout by redirecting the payer's browser from their website to Hosted Checkout.
ENABLE_CLICK_TO_PAY
Enables the merchant for the Click to Pay functionality. It can only be enabled if it is available in the merchant's country for at least one scheme. Once enabled, the merchant can enroll for each scheme for Click to Pay and enable it on their merchant profile via Merchant Administration.
ENABLE_DECRYPT_APPLE_PAY
Enables the merchant to present Apple Pay payment tokens.
ENABLE_DECRYPT_GOOGLE_PAY
Enables the merchant to present Google Pay payment tokens.
ENABLE_DECRYPT_SAMSUNG_PAY
Enables the merchant to present Samsung Pay payment tokens.
ENABLE_DEVICE_PAYMENTS
Enables the merchant to use supported device payment methods such as Apple Pay, Android Pay or Samsung Pay.
ENABLE_GOOGLE_PAY_ON_HOSTED_CHECKOUT
Enables the merchant to use Google Pay on HCO where decryption is done using gateway managed certificate.
ENABLE_HOSTED_PAYMENT_FORM
Enables the merchant to collect the payer's payment details through their own payment form while submitting them directly from the payer's browser to the gateway.
ENABLE_MASTERPASS_ONLINE
Enables the merchant to use the MasterPass Online digital wallet to collect the payer's payment details.
ENABLE_MSO_CONFIGURED_TRANSACTION_FILTERING
Enables you to configure transaction filtering rules for this merchant. If you enable this service, you should also configure the rules you want to apply in the merchant.transactionFiltering parameter group.
ENABLE_NOTIFICATIONS
Enables the merchant to configure merchant email notifications as well as customer email notifications.
ENABLE_OPEN_BANKING_VIA_FINICITY
Enables the merchant to use Open Banking via Finicity for Bank to Bank Account Transfer Set Up and Payment Services.
ENABLE_PAYMENTS_WITHOUT_AUTHENTICATION
Enables the merchant to process payments without any merchant authentication.
ENABLE_PAY_WITH_TOKEN
Enables the merchant to use Pay with Token for Hosted Checkout.
ENABLE_REPORTING_API
Enables the merchant to integrate with the gateway via the Reporting API.
ENABLE_SUBGATEWAY_PROCESSING
Enables the merchant to act as a subgateway. A subgateway can submit requests to the gateway on behalf of their client merchants to access gateway services. Client merchants of the subgateway do not need merchant profiles created on the gateway.
ENABLE_VISA_CHECKOUT
Enables the merchant to use the Visa Checkout digital wallet to collect the payer's payment details.
ENABLE_WEB_SERVICES_API
Enables the merchant to integrate with the gateway via the Web Services API. The Authentication mode is set to 'Password Authentication'.
Use this parameter group to add the configuration or similar properties for a merchant enabled to use any gateway or integrated third party services as defined at the time of onboarding.
Use this parameter group to add the configuration or similar properties for a merchant for the gateway or third party service as defined at the time of onboarding.
String
REQUIRED
The configuration property name that needs to be set up at the gateway for the gateway or third party service to work for your merchant.
These values will be shared as part of your onboarding process.
Data can consist of any characters
String
REQUIRED
The configuration property value, for the property name provided alongside this property value, that needs to be set up at the gateway for the gateway or third party service to work for your merchant.
Data can consist of any characters
Enumeration
REQUIRED
Use this field to indicate the gateway or integrated third party service for which you wish to set up the configuration properties for the merchant at gateway.
Value must be a member of the following list. The values are case sensitive.
OPEN_BANKING_VIA_FINICITY
Allows you to set up Finicity Configuration parameters at the gateway
Information about a merchant you have enabled to act as a subgateway.
These fields only apply if you have set ENABLE_SUBGATEWAY_PROCESSING in the merchant.service[n] field.
Use these fields to provide information so that our gateway can process requests submitted by this merchant on behalf of their client merchants.
String
OPTIONAL
This lets you limit the scope of this subgateway to the client merchants that they own.
The gateway will only process requests from this subgateway merchant that have a acquirer.merchantId value that is in this list.
The acquirer.merchantId is the Bank Merchant ID/SE Number/account name or such issued by this acquirer. You can specify a list of either:
- • merchant ids, or
- • a dash separated range (inclusive) of merchant ids.
- kddfg\-x, eam1340-eam1343,a8-a11,009-011,x y
- kddfg-x, eam1340, eam1341, eam1342, eam1343, a8, a9, a10, a11, 009, 010, 011, x y
Data can consist of any characters
Enumeration
REQUIRED
The card number masking format applied by the gateway when the card number was supplied by the customer rather than the merchant.
This format will be used for transactions originating from Hosted Payment Form integrations.
Formats for masking card numbers.
Value must be a member of the following list. The values are case sensitive.
DISPLAY_0_4
Display last 4 digits of Card Number.
DISPLAY_6_3
Display first 6 and last 3 digits of Card Number.
DISPLAY_6_4
Display first 6 and last 4 digits of Card Number.
DISPLAY_FULL
Display Full Card Number.
DISPLAY_NONE
Display No Card Number.
Configuration details for the Tokenization functionality
Enumeration
OPTIONAL
Enable the use of Amex scheme tokens from the selected token repository for this merchant.
Where enabled, the gateway will use the scheme token (rather than the actual card details) stored against the gateway token when processing a request with this gateway token. Tokenization of card details with Amex scheme tokens requires additional configuration on the merchant.tokenization.tokenRepository.schemeTokenization.amex group.
Value must be a member of the following list. The values are case sensitive.
ENABLE_FOR_PRODUCTION_AND_TEST_MERCHANT_PROFILE
Enable use of network tokens for the production as well as the test merchant profile.
ENABLE_FOR_TEST_MERCHANT_PROFILE_ONLY
Enable use of network tokens for the test merchant profile only.
Enumeration
OPTIONAL
Enable payer authentication with passkey or EMV 3DS via Mastercard Token Authentication Service (TAS), where available.
Where enabled, for transactions with Mastercard scheme tokens, the gateway will attempt to retrieve and use a passkey to authenticate a payer. If the passkey is not available, the gateway will proceed with the 3DS authentication. Payer authentication via TAS for Mastercard requires additional configuration for scheme tokenization on the merchant.tokenization.tokenRepository.schemeTokenization.scof group and for 3DS authentication on merchant.privilege=SECURECODE_2 field.
Value must be a member of the following list. The values are case sensitive.
ENABLE_FOR_PRODUCTION_AND_TEST_MERCHANT_PROFILE
Enable use of network tokens for the production as well as the test merchant profile.
ENABLE_FOR_TEST_MERCHANT_PROFILE_ONLY
Enable use of network tokens for the test merchant profile only.
Enumeration
OPTIONAL
Enable the use of Mastercard Secure Card on File (SCOF) scheme tokens from the selected token repository for this merchant.
Where enabled, the gateway will use the scheme token (rather than the actual card details) stored against the gateway token when processing a request with this gateway token. Tokenization of card details with SCOF requires additional configuration on the merchant.tokenization.tokenRepository.schemeTokenization.scof group.
Value must be a member of the following list. The values are case sensitive.
ENABLE_FOR_PRODUCTION_AND_TEST_MERCHANT_PROFILE
Enable use of network tokens for the production as well as the test merchant profile.
ENABLE_FOR_TEST_MERCHANT_PROFILE_ONLY
Enable use of network tokens for the test merchant profile only.
Boolean
OPTIONAL
The Token Maintenance Service attempts to ensure that the card details stored against a token are current thereby increasing the likelihood of successfully processing a recurring payment that uses the token.
The Token Maintenance Service uses the Account Updater functionality. Therefore the Account Updater functionality must be enabled for at least one Merchant-Acquirer-Link for the merchant. Only tokens with payment details for which requests would be processed via such a Merchant-Acquirer-Link can be updated.
JSON boolean values 'true' or 'false'.
Details regarding the token repository configuration.
Configuration of the token repository assigned to the merchant (as identified in merchant.tokenization.tokenRepositoryId) for scheme tokenization using a scheme token service provider, including Mastercard Digital Enablement Service (MDES), Mastercard Secure Card on File (SCOF), Visa Token Service (VTS) or American Express Token Service (AETS).
Configuration details for the American Express Tokenization Service (AETS).
To enable Amex scheme tokenization using AETS, you must provide the Business Name, SE ID, Email, Country and Website of the merchant to the gateway to register the merchant for Amex scheme tokenization service.
Once enabled, you cannot disable the use of Amex scheme tokenization.
The address details of the merchant for configuration with Amex.
String
OPTIONAL
The country of the merchant's primary address.
Provide the ISO 3166-1 three-letter country code.
Data can consist of any characters
String
OPTIONAL
A bank merchant ID, also known as service establishment identifier or SE ID, is a unique code assigned to the merchant by American Express when the merchant opens an account.
If a merchant has multiple SE IDs, use the parent SE ID. You may need to contact the merchant to obtain the SE ID. Please verify the SE ID before submitting. Min length: 1 Max length: 25
Data can consist of any characters
String
OPTIONAL
The business name of the merchant that you are registering with Amex.
Min length: 1 Max length: 255
Data can consist of any characters
Email
OPTIONAL
The email address of the primary contact at the merchant, that can be used to contact the merchant.
Min length: 3 Max length: 254
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Url
OPTIONAL
The URL of the merchant's website.
Min length: 1 Max length: 999
Ensure that this is a valid URL according to RFC 1738.
Configuration details for the Mastercard Digital Enablement Service (MDES).
If a token requestor ID (TRID) is contained in the Retrieve Transaction response in field merchant.tokenization.tokenRepository.schemeTokenization.mdes.tokenRequestorId, the repository is enabled for scheme tokenization for all Mastercard cards stored in this repository.
To enable scheme tokenization using MDES, you can either provide an existing token requestor ID (TRID) or provide the merchant trading name to request the gateway to register the merchant for scheme tokenization with MDES and retrieve a TRID.
Once enabled, you cannot disable scheme tokenization using MDES.
String
OPTIONAL
The trading name of the merchant.
If provided and the repository is not yet enabled for scheme tokenization (i.e. merchant.tokenization.tokenRepository.schemeTokenization.mdes.tokenRequestorId is not present) the gateway will attempt to enabled scheme tokenization with MDES by registering the merchant with MDES and retrieving a token requestor ID (TRID).
If the registration was successful the Retrieve Merchant response contains the TRID in field merchant.tokenization.tokenRepository.schemeTokenization.mdes.tokenRequestorId and the repository is enabled for scheme tokenization for Mastercard cards.
Data can consist of any characters
String
OPTIONAL
A unique identifier (also known as TRID) assigned to the merchant by MDES.
This identifier will be used by the gateway in all requests to MDES to identify the merchant. The same TRID will be used for all merchant profiles using this token repository,
If you want to enable the token repository for scheme tokenization for gateway tokens and the merchant has already been assigned a TRID by MDES, provide this TRID.
Once a TRID has been configured for a token repository, it cannot be updated. In case you need to update the TRID you must create a new token repository.
Data can consist of any characters
Configuration details for Mastercard Secure Card on File (SCOF).
To enable scheme tokenization using SCOF, you must provide the merchant trading name to request the gateway to register the merchant for scheme tokenization with SCOF.
Once enabled, you cannot disable scheme tokenization using SCOF.
String
OPTIONAL
The trading name of the merchant.
If provided and the repository is not yet onboarded to SCOF for scheme tokenization (i.e. merchant.tokenization.tokenRepository.schemeTokenization.scof.status is not ENABLED or REQUESTED), the gateway will attempt to enable scheme tokenization with SCOF by registering the merchant with SCOF and retrieving the status of the registration.
If the registration was successful, the Retrieve Merchant response contains the merchant.tokenization.tokenRepository.schemeTokenization.scof.status as ENABLED and the repository is enabled for scheme tokenization for Mastercard cards.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates whether Mastercard Secure Card on File (SCOF) tokenization functionality is enabled for the token repository assigned to the merchant (as identified in merchant.tokenization.tokenRepositoryId).
Do not provide this field in the request. If provided in the request, it will be ignored.
Data can consist of any characters
Value must be a member of the following list. The values are case sensitive.
ENABLED
The token repository is enabled for Mastercard Secure Card on File (SCOF) tokenization.
FAILED
The token repository enablement for Mastercard Secure Card on File (SCOF) tokenization has been unsuccessful.
FAILED_MISMATCHED_TRADING_NAME
The token repository cannot be enabled for Mastercard Secure Card on File (SCOF) tokenization as the provided merchant trading name doesn't match the merchant name originally registered with MDES.
REQUESTED
The token repository enablement for Mastercard Secure Card on File (SCOF) tokenization is in progress.
Configuration details for the Visa Token Service (VTS).
If a token requestor ID (TRID) is contained in the Retrieve Transaction response in field merchant.tokenization.tokenRepository.schemeTokenization.vts.tokenRequestorId the repository is enabled for scheme tokenization for all Visa cards stored in this repository.
To enable scheme tokenization using VTS, you can either provide an existing token requestor ID (TRID) and relationship ID (if available) or you provide the merchant details, including the merchant's name, country, city, email, website and business identifier, to request the gateway to register the merchant for scheme tokenization with VTS and retrieve a TRID.
Once enabled, you cannot disable scheme tokenization using VTS.
Details about the merchant, to be used by the gateway to register the merchant with VTS to enable the token repository for scheme tokenization for Visa cards
You must provide these details if you want to enable scheme tokenization for Visa cards for the repository and the merchant has not yet been issued a TRID by VTS.
Enumeration
REQUIRED
The type of the business identifier you have provided in field merchant.tokenization.tokenRepository.schemeTokenization.vts.merchant.businessIdentifier.
The Business Identifier Type must be valid in the country you provide in merchant.tokenization.tokenRepository.schemeTokenization.vts.countryCode, for example, if the merchant is located in Canada, you can provide either the merchant's BID (Business Identification Number) or BN (Business Number).
Value must be a member of the following list. The values are case sensitive.
| ABN | Australian Business Number |
| BID | Business Identification Number |
| BN | Business Number |
| BRNO | Business Registration Number |
| CID | Company Identifier |
| CL | Commercial License Number |
| CLN | Company License Number |
| CNPJ | Legal Entities National Registration Number |
| CR | Company Registration Number |
| CUIT | Unique Tax Identification Code |
| EDRPOU | Unified State Register of Enterprises and Organizations of Ukraine |
| EIN | Federal Tax ID |
| HKBR | Hong Kong Business Registration |
| NATIONAL_ID | Dominican Republic National Identity |
| NZBN | New Zealand Business Number |
| PAN | Permanent Account Number |
| RFC | Federal Taxpayer Registration |
| RNC | Dominican Republic National Contributors Number |
| RUC | Unique Registry of Taxpayers |
| RUT | Unique Taxpayer Identification Number |
| SIN | Social Insurance Number |
| SSN | Social Security Number |
| UEN | Unique Entity Number |
| VAT | Value Added Tax |
Value must be a member of the following list. The values are case sensitive.
ABN
BID
BN
BRNO
CID
CL
CLN
CNPJ
CR
CUIT
EDRPOU
EIN
HKBR
NATIONAL_ID
NZBN
PAN
RFC
RNC
RUC
RUT
SIN
SSN
UEN
VAT
String
REQUIRED
The business identifier of the merchant, for example their tax registration identifier.
Provide the value of the identifier you have provided in field merchant.tokenization.tokenRepository.schemeTokenization.vts.merchant.businessIdentificationType.
Data can consist of any characters
String
REQUIRED
The city of the merchant's primary address.
Data can consist of any characters
Upper case alphabetic text
REQUIRED
The country of the merchant's primary address.
Provide the ISO 3166-1 three-letter country code.
Data must consist of the characters A-Z
Email
REQUIRED
The email address that can be used to contact the merchant.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
REQUIRED
The registered or legal name of the merchant.
Note that this may differ from the trading name that payers know the merchant by.
Data can consist of any characters
Url
REQUIRED
The URL of the merchant's web site.
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
An identifier assigned to the merchant by VTS, in addition to the token requestor ID (TRID).
This identifier will be used by the gateway in all requests to VTS. The same identifier will be used for all merchant profiles using this token repository.
If you want to enable the token repository for scheme tokenization for gateway tokens and the merchant has already been assigned a TRID and relationship ID by VTS, provide this relationship ID.
Once a relationship ID has been configured for a token repository, it cannot be updated. In case you need to update the relationship ID you must create a new token repository.
Data can consist of any characters
String
OPTIONAL
A unique identifier (also known as TRID) assigned to the merchant by VTS.
This identifier will be used by the gateway in all requests to VTS to identify the merchant. The same TRID will be used for all merchant profiles using this token repository.
If you want to enable the token repository for scheme tokenization for gateway tokens and the merchant has already been assigned a TRID by VTS, provide this TRID.
Once a TRID has been configured for a token repository, it cannot be updated. In case you need to update the TRID you must create a new token repository.
Data can consist of any characters
Enumeration
OPTIONAL
Defines the strategy used to generate a token.
Mandatory, if repository must be created.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_SUPPLIED
Tokens are supplied by the merchant. Any merchant supplied token is validated to not be a valid card number.
PRESERVE_6_4
Tokens are generated preserving the first 6 and last 4 digits of the account identifier, e.g. card number. The remaining digits are randomized, and the token is guaranteed to fail a Luhn (Mod-10) check so that it does not create a valid card number.
RANDOM_WITH_LUHN
Tokens are generated as random numbers. It starts with a '9' (so that is does not create a valid card number) and passes a Luhn (Mod-10) check.
Enumeration
OPTIONAL
Defines how tokens within the repository are managed by the gateway.
Mandatory, if repository must be created.
Value must be a member of the following list. The values are case sensitive.
UNIQUE_ACCOUNT_IDENTIFIER
A single token is assigned against an account identifier, defines as a one-to-one relationship between the account identifier and the token. An attempt to store the account identifier against another token will result in an error.
UNIQUE_TOKEN
A unique token is assigned every time an account identifier is saved in the token repository, defining a one-to-many relationship between an account identifier and the token.
ASCII Text
OPTIONAL
Unique identifier of the token repository.
Token repositories can be shared across merchants; however, a single merchant can be associated with only one token repository at a given time. Every token repository has a corresponding test token repository, which only the merchants with the corresponding test profiles can access. For example, if the repository ID is ABC, the test repository ID will be TestABC. Hence, the system displays an error if you specify a repository ID that starts with 'Test'
Data consists of ASCII characters
Enumeration
OPTIONAL
The type of verification performed by the gateway for payment details stored against a token repository for this merchant.
Value must be a member of the following list. The values are case sensitive.
ACQUIRER
The gateway performs a Web Services API Verify request. Depending on the payment type, you may need to provide additional details to enable the submission of a Verify request.
BASIC
The gateway validates the format of the payment details. For cards it also validates that the card number falls within a valid BIN range. For ACH payment details it also validates the check digit for the routing number
NONE
The gateway does not perform any verification.
Enumeration
OPTIONAL
Enable the use of VTS scheme tokens from the selected token repository for this merchant.
Where enabled, the gateway will use the scheme token (rather than the actual card details) stored against the gateway token when processing a request with this gateway token. Tokenization of card details with VTS requires additional configuration. This configuration is currently only available in Merchant Manager.
Value must be a member of the following list. The values are case sensitive.
ENABLE_FOR_PRODUCTION_AND_TEST_MERCHANT_PROFILE
Enable use of network tokens for the production as well as the test merchant profile.
ENABLE_FOR_TEST_MERCHANT_PROFILE_ONLY
Enable use of network tokens for the test merchant profile only.
Configuration of transaction filtering rules that apply to transactions processed by this merchant.
You only need to set this if you want to define rules for this merchant, in addition to those that you have configured to apply to all of your merchants, and in addition to the rules defined by the merchant themselves.
The gateway complies with all configured rules when determining if a transaction should be processed.
Transaction filtering rules based on the results of 3-D Secure payer authentication.
These rules enable the gateway to reject or mark transactions for review, based on rules you can configure.
You only need to use this parameter group if you want to specify rules to apply to this merchant and therefore override any global filtering rules you have set.
You can set values for only one of customFilter, managedFilters, or noFilter. If you provide none of these values, the gateway will apply any global filtering rules that you have specified.
String
OPTIONAL
The name of the 3DS1 custom rule set that you want to apply to this merchant's transactions.
Use this field if the managed rules provided by the gateway are not suitable. Note: You must first provide the gateway with your custom rule set using the MSO UI.
Data can consist of any characters
String
OPTIONAL
The name of the 3DS2 custom rule set that you want to apply to this merchant's transactions.
Use this field if the managed rules provided by the gateway are not suitable. Note: You must first provide the gateway with your custom rule set using the MSO UI.
Data can consist of any characters
This group lets you select filtering rules managed by the gateway.
If you use this, then you must select at least one field in this parameter group.
Boolean
OPTIONAL
Block e-commerce transactions where 3-D Secure authentication of the payer has not been attempted.
That is, a directory server lookup was not attempted, or an 'Enrolled' response was not followed by an ACS interaction.
JSON boolean values 'true' or 'false'.
Boolean
OPTIONAL
Block e-commerce transactions where 3-D Secure authentication of the payer has not resulted in liability shift to the issuer.
JSON boolean values 'true' or 'false'.
Boolean
OPTIONAL
Block e-commerce transactions where the cardholder has not been successfully authenticated with 3-D Secure.
JSON boolean values 'true' or 'false'.
Boolean
OPTIONAL
Block e-commerce transactions based on the gateway's evaluation of the 3-D Secure authentication results against recommendations for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, Discover ProtectBuy™, ITMX LSS, UnionPay 3-D Secure and Jaywan SecureNxt.
Based on this assessment, the transaction will be blocked or processed as fully authenticated, authentication attempted, or as an unauthenticated transaction.
JSON boolean values 'true' or 'false'.
Boolean
OPTIONAL
No 3-D Secure filtering is applied to the merchant's transactions.
Use this option when you have configured global 3-D Secure filters that apply to all of your merchants and do not want that filtering to apply to this merchant.
JSON boolean values 'true' or 'false'.
Transaction filtering rules based on card BIN ranges.Block transactions for this merchant where the BIN for the card number is in this range.
Note that you can either configure a set of BIN ranges for which requests will be blocked (blacklist)or a set of BIN ranges for which requests will be allowed (whitelist), but not both.
When defining a blacklist, all requests with card numbers outside the defined BIN ranges are allowed.When defining a whitelist, all requests with card numbers outside the defined BIN ranges will be blocked.
Integer
OPTIONAL
The last BIN of the BIN range you want blocked.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
REQUIRED
The first BIN of the BIN range you want blocked.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Transaction filtering rules for IP addresses.
Transactions originating from an IP address in these ranges will be blocked.
IpAddress
OPTIONAL
The last IP address of an IP address range to be blocked, in nnn.nnn.nnn.nnn format.
Ensure that the IpAddress is in the format n.n.n.n, where each n is in the range of 0 to 255
IpAddress
REQUIRED
The first IP address of an IP address range to be blocked, in nnn.nnn.nnn.nnn format.
Ensure that the IpAddress is in the format n.n.n.n, where each n is in the range of 0 to 255
Enumeration
OPTIONAL
Block transactions based on the absence of the Card Security Code (CSC) or the response from the card issuer.
Value must be a member of the following list. The values are case sensitive.
REJECT_CSC_NOT_PRESENT_ON_CARD
Rejects transactions where the merchant has indicated that CSC is not present on the card.
REJECT_ISSUER_NOT_CERTIFIED
Rejects transactions for which the issuer is not certified for CSC processing.
REJECT_NOT_PROCESSED
Rejects transactions where the CSC is not processed.
REJECT_NO_CSC_MATCH
Rejects transactions where the CSC submitted is invalid or does not match the one associated with the card.
Boolean
OPTIONAL
Enable Dynamic 3-D Secure Authentication for this merchant.
The merchant can only be enabled for this functionality if they are configured for at least one 3-D Secure authentication scheme and also configured to use an external risk provider (merchant.merchantManagedRiskAssessment parameter group).
JSON boolean values 'true' or 'false'.
Transaction filtering rules for countries based on IP address.
Transactions originating from IP addresses associated with the countries you specify will be blocked. You can also choose to block transactions from unidentified countries or anonymous proxy servers.
Boolean
OPTIONAL
Block transactions originating from anonymous proxy servers.
Do not set to 'false' if merchant.transactionFiltering.ipCountry.rejectCountry is populated.
JSON boolean values 'true' or 'false'.
Alpha
OPTIONAL
Block transactions originating from IP addresses associated with this country.
Provide the 3 character ISO 3166-1 alpha-3 country code of the country to be blocked.
Data may consist of the characters a-z, A-Z
Boolean
OPTIONAL
Block transactions from IP addresses when the gateway cannot identify the country from which it originated.
Do not set to 'false' if merchant.transactionFiltering.ipCountry.rejectCountry is populated.
JSON boolean values 'true' or 'false'.
Transaction filtering rules based on card BIN ranges.Allow transactions for this merchant where the BIN for the card number is in this range.
Note that you can either configure a set of BIN ranges for which requests will be blocked (blacklist)or a set of BIN ranges for which requests will be allowed (whitelist), but not both.
When defining a blacklist, all but requests with card numbers within the defined BIN ranges are allowed.When defining a whitelist, all but requests with card numbers within the defined BIN ranges will be blocked.
Integer
OPTIONAL
The last BIN of the BIN range you want whitelisted.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
REQUIRED
The first BIN of the BIN range you want whitelisted.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
String
OPTIONAL
Provide an abbreviation of the merchant's trading name that can be used by the issuer to indicate the merchant on the payer's statement.
For Installment Service Providers this field is mandatory, because the issuer may want to use both the name of the Installment Service Provider and the name of the retailer from whom the payer purchased the goods or services. The merchant must provide the abbreviated retailer trading name on the transaction request.
Data can consist of any characters
The address of the merchant.
String
REQUIRED
The city or town of the merchant's billing address.
Data can consist of any characters
Upper case alphabetic text
REQUIRED
The country of the merchant's billing address.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
String
REQUIRED
The zip or postal code of the merchant's billing address.
Data can consist of any characters
String
REQUIRED
The state or province code of the merchant's billing address.
For merchants in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.
For Canadian merchants provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
String
REQUIRED
The street address of the merchant's billing address.
Data can consist of any characters
String
OPTIONAL
The street address of the merchant's merchant's billing address.
Data can consist of any characters
Digits
REQUIRED
A 4 digit industry specific code that describes the business or industry the merchant operates in.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The name of the person to contact within the merchant's business.
Data can consist of any characters
Email
OPTIONAL
The email address of the person to contact within the merchant's business.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The phone number to call in case the regular phone number is not available.
Data can consist of any characters
String
OPTIONAL
The fax number of the merchant's business.
Data can consist of any characters
String
REQUIRED
Description of the merchant's goods, for example, books or electronics.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
Provide this value only if a merchant is govt.
controlled merchant. A merchant is considered a government owned or controlled entity (government controlled merchant) if 50% or more of the merchant is owned by the government. Provide the ISO 3166 three-letter country code of the government country where this differs from the merchant's physical location country.
Data must consist of the characters A-Z
String
REQUIRED
The default language displayed in Merchant Administrator unless overridden by the Operator.
The value must be provided in the format '<Language>_<Country>', e.g. 'en_US'. <Language> must be a two-letter language code according to ISO 639-1. <Country> must be a two-letter country code according to ISO 3166-1 alpha-2.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
Where the country of the physical location of the merchant using this merchant profile differs from the country provided for the merchant address (in the 'Contact Details' section), this is the country of the physical location.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
Alphanumeric
OPTIONAL
The Mastercard Assigned ID (MAID), a unique 6-digit identifier assigned to the merchant by Mastercard.
For example, Mastercard assigns a MAID when the acquirer registers the merchant for a particular program or for transaction data integrity purposes.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric + additional characters
OPTIONAL
The merchant organizations that this merchant belongs to.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
String
OPTIONAL
The mobile phone number to call in case the regular phone number is not available.
Data can consist of any characters
String
REQUIRED
The merchant's registered business, trading or organization name.
This should match the merchant name provided during registration with scheme Directory Servers if you process 3-D Secure authentication.
Data can consist of any characters
String
OPTIONAL
A unique ID of the reseller partner or a referral partner the merchant has signed up with, to use the services offered by the MSO.
Providing this ID will help in tracking and analyzing the relationship between partners and their merchants, which may be useful for billing and reporting purposes.
Data can consist of any characters
String
OPTIONAL
The phone number of the merchant's business.
Data can consist of any characters
Enumeration
OPTIONAL
Use this field to indicate whether or not the merchant may use gateway features configured on their merchant profile.
By default this field is set to ENABLED.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The merchant cannot use any of the gateway features configured on their merchant profile and cannot log into merchant UIs.
ENABLED
The merchant may use all of the gateway features configured on their merchant profile and may also log into merchant UIs.
String
REQUIRED
Defines the default time zone used for merchant operators in Merchant Administration, unless overridden by the operator.
It is used to display the transaction time. The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of timezones please refer to http://twiki.org/cgi-bin/xtra/tzdatepick.html.
Data can consist of any characters
String
OPTIONAL
A unique identifier allocated to the merchant by ANZ Worldline Payment Solutions if different from the Merchant ID.
Data can consist of any characters
String
OPTIONAL
The trading name of the merchant's business if it is different to that of the company name.
Data can consist of any characters
Enumeration
OPTIONAL
The type of merchant.
You must provide this field if the merchant falls into any of the categories other than STANDARD. If not provided, the value is defaulted to STANDARD.
Value must be a member of the following list. The values are case sensitive.
AGGREGATOR
The merchant submits transaction requests to the gateway on behalf of their sub merchants. This is also known as 'payment facilitator'.
INSTALLMENT_SERVICE_PROVIDER
The merchant charges payers for an installment payment agreement for a purchase of goods or services that the payer made from another merchant.
MARKETPLACE
The merchant runs a platform where other merchants can sell goods or services.
STANDARD
The merchant is neither an aggregator, nor an installment service provider or marketplace. This is the default value.
Alphanumeric
OPTIONAL
The Visa Merchant Identifier (VMID), a unique 8-digit identifier assigned to the merchant by Visa.
For example, Visa assigns a VMID when the acquirer registers the merchant for a particular program or for transaction data integrity purposes.
Data may consist of the characters 0-9, a-z, A-Z
Url
OPTIONAL
URL of the merchant's website.
This is mandatory if the merchant is enrolled in a 3DSecure scheme.
Ensure that this is a valid URL according to RFC 1738.
Details about the merchant acquirer link.
Please note:
- Not all fields are supported for all acquirers, please refer to the Online Integration Guide for details.
- You cannot delete a merchant acquirer link, however you can set merchantAcquirerLink.status to DISABLED.
Alphanumeric + additional characters
REQUIRED
An identifier to uniquely identify an acquirer link for the merchant on the gateway.
Use this identifier to specify an acquirer link when updating details for that acquirer link.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Boolean
OPTIONAL
Allows you to enable the Account Updater functionality for this merchant acquirer link.
Account Updater provides updates received on cardholder accounts from participating issuers to the associated card schemes. To enable the merchant to receive these updates, your merchant must register for this feature with the acquirer and the associated card schemes. If Account Updater is enabled,
- you can enable the Token Maintenance Service functionality for the merchant and
- the merchant can request account updates for tokens that contain payment details for which transaction requests are processed via this acquirer.
JSON boolean values 'true' or 'false'.
Details regarding an NPCI acquirer link configuration.
Boolean
OPTIONAL
Defines if merchant is a small merchant in accordance with the RBI(Reserve Bank of India) guidelines.
JSON boolean values 'true' or 'false'.
Enumeration
OPTIONAL
The transaction frequency the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction frequencies.
Note: If you set this value it will only apply if the merchant uses version 53 and lower of the API.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
OPTIONAL
The transaction sources the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction sources.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
OPTIONAL
The time each day, at which automatic settlement of transactions with the acquirer should be triggered by the gateway.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
A 4-digit code used to classify the merchant's business by the type of goods or services it offers.
This is also known as the Merchant Category Code (MCC).
You can provide a single MCC or multiple MCCs as a comma-separated list (the first entry will be used as the default). When you specify multiple MCC values, the merchant can provide an MCC value from this list to use for a transaction.
You can also specify the value 'ANY' (only if supported by the acquirer) to enable the merchant to provide any MCC value for a transaction.
Data may consist of the characters 0-9, a-z, A-Z, ','
String
OPTIONAL
The Bank Merchant ID/SE Number is an identifier allocated to the merchant by their acquiring bank.
If you set up more than one acquirer link for a single acquirer, these do not need to use the same Bank Merchant ID.
Data can consist of any characters
String
OPTIONAL
The identifier for the set of card BINs that are allowed to be processed using this acquirer link.
Use this field to ensure that transactions performed with a card with a BIN in this set is routed via this acquirer link. For example, domestic card transactions must be routed to a specific merchant acquirer link and cross-border transactions can be routed to a different link. The same card BIN set may be set up on multiple acquirer links, however, the combination of line of business, payment type, currency, and card BIN set must be unique on each acquirer link. Note: this identifier must match the one assigned by the gateway for the card BIN set.
Data can consist of any characters
String
OPTIONAL
The list of valid card types supported by this merchant acquirer link.
Data can consist of any characters
Alphanumeric
REQUIRED
The list of currencies supported for this merchant acquirer link, expressed using the three-letter alphabetic code according to ISO-4217 must be provided, e.g. "USD" for United States Dollar.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
REQUIRED
The merchants default transaction frequency must be one of the allowable transaction frequencies for this merchant.
Defines the transaction frequency set, if none has been provided for that transaction.
Note: If you set this value it will only apply if the merchant uses version 53 and lower of the API.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
REQUIRED
The merchants default transaction source must be one of the allowable transaction sources for this merchant.
Defines the transaction source sent to the acquirer, if none has been provided for that transaction.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
Enumeration
OPTIONAL
Allows you to specify transaction sources for which a Card Security Code (CSC) must be provided when processing transactions using this merchant acquirer link.
CSC enforcement does not apply to:
- Merchant-initiated transactions.
- Card Present transactions.
- Transactions with Maestro cards for a transaction source of Internet.
CSC enforcement only applies to Authorization, Purchase, and Standalone Capture transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MERCHANT
The merchant can set Merchant as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
Allows you to define exclusion rules for transactions that must not be processed via the merchant acquirer link based on the combination of card type, funding method and issuer country.
For example, if the merchant acquirer link is configured for card types Mastercard and Visa but you want to exclude all Debit cards issued in Canada, provide merchant.acquirerLink.exclusionRules[0].fundingMethods[DEBIT] and merchant.acquirerLink.exclusionRules[0].issuingCountries=[CAN].
Comma separated strings
OPTIONAL
Provide the list of card types for which the exclusion rule applies.
You can only specify card types that are supported by this merchant acquirer link. If this field is not provided or is provided and empty, the exclusion rule will be applied to all card brands.
Data can consist of any characters
Comma separated strings
OPTIONAL
Provide the list of issuer countries for which the rule does not apply.
The rule will be applied to all but the countries listed. If the exclusion rule applies to a small number of countries, you may instead want to define the list of countries to which the exclusion rule applies, in field merchant.acquirerLink.exclusionRules[n].issuerCountries. If neither merchant.acquirerLink.exclusionRules[n].issuerCountries nor merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries are provided, the exclusion rule will be applied for all issuer countries. Provide the three-letter country code according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Comma separated enumeration
OPTIONAL
Provide the list of funding methods for which the exclusion rule applies.
If this field is not provided or is provided and empty, the exclusion rule will be applied to all funding methods.
Value must be one or more comma separated members of the following list. The values are case sensitive.
CREDIT
The payer has a revolving line of credit with the issuer.
DEBIT
Funds are immediately debited from the payer's account with the issuer.
CHARGE
The payer has a line of credit with the issuer which must be paid off monthly.
UNKNOWN
The account funding method could not be determined.
Comma separated strings
OPTIONAL
Provide the list of issuer countries for which the exclusion rule applies.
If the exclusion rule applies to a large number of countries, you may instead want to define the list of countries to which the exclusion rule does not apply, in field merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries. If neither merchant.acquirerLink.exclusionRules[n].issuerCountries nor merchant.acquirerLink.exclusionRules[n].excludedIssuerCountries are provided, the exclusion rule will be applied for all issuer countries. Provide the three-letter country code according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Enumeration
OPTIONAL
Defines how transactions for which the gateway is unable to determine the issuer country should be handled.
Value must be a member of the following list. The values are case sensitive.
EXCLUDED
The exclusion rule will not be applied to requests where the issuer country could not be determined by the gateway.
INCLUDED
The exclusion rule will be applied to requests where the issuer country could not be determined by the gateway.
String
OPTIONAL
Description of the goods sold by the merchant, for example, books or electronics.
Data can consist of any characters
String
OPTIONAL
The time the merchant's business day ends.
If you provide this field the gateway will ensure that all transactions submitted by the merchant within the same business day are settled in the same acquirer settlement file.
Data can consist of any characters
String
OPTIONAL
The time zone for the merchant's business day.
The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of time zones please refer to https://www.iana.org/time-zones.
Data can consist of any characters
String
OPTIONAL
If, when integrating with the gateway, the merchant is using a solution (e.g. a shopping cart or e-commerce solution) that you provide, support or certify, you may want to use this field to provide a unique identifier for the solution.
Data can consist of any characters
Enumeration
REQUIRED
The payment types supported by this acquirer via this merchant acquirer link.
Value must be a member of the following list. The values are case sensitive.
ACH
The acquirer supports ACH payments.
ALIPAY
The acquirer supports Alipay payments.
BANCANET
The acquirer supports BancaNet Directo online browser payments.
BANCONTACT
The acquirer supports Bancontact payments.
BLIK
The acquirer supports BLIK payments.
BOLETO_BANCARIO
The acquirer supports Boleto Bancario payments.
BROWSER_PAYMENT
The acquirer supports browser payments. Refer to the merchant.acquirerLink.{id}.browserPayment parameter group for additional details.
CREDIT
The acquirer supports credit cards, debit cards such as Maestro Debit card, and/or Visa debit cards.
DIRECT_DEBIT_CANADA
The payer selected the payment method Direct Debit Canada
ENETS
The acquirer supports eNETS payments.
EPS_UEBERWEISUNG
The acquirer supports eps-Überweisung payments.
GIFT_CARD
The acquirer supports Gift Card payments.
GIROPAY
The acquirer supports giropay online browser payments.
GRABPAY
The acquirer supports GrabPay payments.
IDEAL
The acquirer supports iDEAL payments.
KLARNA_FINANCING
The acquirer supports Klarna Financing payments.
KLARNA_PAY_LATER
The acquirer supports Klarna Pay Later payments.
KLARNA_PAY_NOW
The acquirer supports Klarna Pay Now payments.
MERCADO_PAGO_CHECKOUT
The acquirer supports Mercado Pago Checkout payments.
MULTIBANCO
The acquirer supports Multibanco payments.
OPEN_BANKING_BANK_TRANSFER
The acquirer supports Open Banking Bank Transfer payments.
OXXO
The acquirer supports OXXO payments.
PAYCONIQ
The acquirer supports Payconiq payments.
PAYPAL
The acquirer supports PayPal online browser payments.
PAYSAFECARD
The acquirer supports paysafecard payments.
PAYU
The acquirer supports PayU payments.
PBBA
The acquirer supports pay by bank app payments.
POLI
The acquirer supports POLi payments.
PRZELEWY24
The acquirer supports Przelewy24 payments.
REWARD
The acquirer supports reward points payments.
SEPA
The acquirer supports SEPA payments.
SOFORTBANKING
The acquirer supports Sofortbanking online browser payments.
TRUSTLY
The acquirer supports Trustly payments.
UNION_PAY
The acquirer supports UnionPay SecurePay browser payments.
WECHAT_PAY
The acquirer supports WeChatPay payments.
Configuration of the merchant-acquirer link to use exemptions from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area.
Integer
OPTIONAL
The merchant's fraud rate, as determined by the acquirer, expressed in basis points (bps).
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Enumeration
OPTIONAL
A list of Payment Services Directive 2 (PSD2) exemptions that the merchant can claim.
Provide a comma-separated list of applicable values.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_OUTAGE
Allows the merchant to claim an exemption because authentication was not possible due to a technical outage.
LOW_RISK
Allows the merchant to claim an exemption because the acquirer has a low fraud rate.
SCA_DELEGATION
Allows the merchant to claim an exemption where the issuer has delegated Strong Customer Authentication (SCA) using a compliant method to a third party.
SECURE_CORPORATE_PAYMENT
Allows the merchant to claim an exemption because the transaction is a corporate or Business-to-Business (B2B) payment performed using dedicated payment processes and protocols that are not available to consumers and offer at least equivalent security levels.
Enumeration
REQUIRED
Defines if the merchant can use the acquirer link and if so, for what purpose.
Note:
Setting the value to FALLBACK can be used to support moving processing of the merchant's transactions from one acquirer link to another.
When moving transaction processing from one link to another, the status of the new link is set to TEST_AND_PRODUCTION or TEST_ONLY, and the status of the old link is set to FALLBACK. In this case,
- New orders will be processed using the new link, and
- Subsequent transactions for orders created using the old link will be processed on the old link.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The acquirer link can no longer be used by the merchant.
FALLBACK
The acquirer link is used to process transactions when no other suitable test or production link is available, or to process subsequent transactions on a order that was created on this link.
TEST_AND_PRODUCTION
The acquirer link can be used for testing and processing live transactions.
TEST_ONLY
The acquirer link can be used for testing only but not processing live transactions.
Alphanumeric
OPTIONAL
The unique identifiers for the terminal IDs, that the acquirer assigned to the merchant.
Data may consist of the characters 0-9, a-z, A-Z
Hex
OPTIONAL
The Merchant Verification Value (MVV) assigned to the merchant by Visa.
Value will be submitted to the acquirer on transaction requests with card type Visa (if supported).
Data is hexadecimal encoded
Use this parameter group to configure the merchant acquirer link for the Account Updater functionality for Mastercard using the Automatic Billing Updater (ABU) and Visa using the Visa Account Updater (VAU) functionality.
Account Updater functionality ensures that, when the merchant submits stored card details on a transaction request, the gateway automatically checks with the specific scheme's Account Updater service that the details are up-to-date before using them for transaction processing. To be able to use the Account Updater functionality the merchant must be enabled for gateway tokenization and the token repository assigned to the merchant must be enabled for Token Management = 'Unique Account Identifier' and Token ID = ' Random With Luhn' or 'Merchant Supplied'.
Alphanumeric
OPTIONAL
The Merchant ID assigned to the merchant by Mastercard when the merchant was onboarded for the Mastercard Automatic Billing Updater (ABU).
If the field is provided, Account Updater functionality for Mastercard cards will be enabled for this merchant.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
The Merchant ID assigned to the merchant by Visa when the merchant was onboarded for Visa Account Updater (VAU).
If the field is provided, Account Updater functionality for Visa cards will be enabled for this merchant.
Data may consist of the characters 0-9, a-z, A-Z
Details that are specific for a specific acquirer.
Aggregator details that need to be updated for the acquirer link.
Alphanumeric
OPTIONAL
The acquirer is responsible for registering the merchant with the applicable scheme (other than Mastercard and Visa) to allow the merchant to act as an aggregator.
The scheme will issue the merchant with a Payment Facilitator ID. This ID will be submitted to the acquirer with every transaction.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
This name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding an AMEX_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an ANZAU_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an ANZNZ_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
ANZ National Bank via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a B+S Card Services acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Details regarding an BancaNet acquirer link configuration.
Digits
OPTIONAL
The merchant's business or establishment number.
This field is mandatory only if the Payment Reference Type is "CAPTURE_A" or "CAPTURE_B".
Data is a number between 101 and 999999 represented as a string.
Digits
OPTIONAL
The identifier used by BancaNet Directo to determine the destination of funds transfer.
The value for this field must be an integer and must not exceed 4 digits.
Data is a number between 0 and 9999 represented as a string.
Digits
OPTIONAL
The merchant's Banamex Electronic Banking ID provided by the merchant when signing the BancaNet Directo contract.
The value for this field must be an integer and must not exceed 12 digits.
Data is a number between 0 and 999999999999 represented as a string.
Digits
OPTIONAL
The identifier for the merchant's bank account number.
This must be the same bank account number, the bank details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999999 represented as a string.
Digits
OPTIONAL
The identifier for the bank branch that holds the merchant's account.
This must be the same bank, the account details of which are registered against the BancaNet Directo account.
Data is a number between 0 and 9999 represented as a string.
Enumeration
OPTIONAL
The merchant's choice of payment reference type when signing the BancaNet Directo contract.
Value must be a member of the following list. The values are case sensitive.
ALPHANUMERIC
The gateway uses the algorithm MOD-97 to generate a alphanumeric Merchant Payment Reference.
BOTH
The gateway uses the algorithm MOD-97 to generate a numeric as well as an alphanumeric for the Merchant Payment Reference.
CAPTURE_A
The merchant's choice of payment reference type is the capture line A.
CAPTURE_B
The merchant's choice of payment reference type is the capture line B.
NUMERIC
The gateway uses the algorithm MOD-97 to generate a numeric Merchant Payment Reference.
Details regarding a Banorte acquirer link configuration.
Alphanumeric
OPTIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Banorte.
Data may consist of the characters 0-9, a-z, A-Z
Bank of China via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding boleto bancario acquirer link configuration.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the merchant.
Data is a string that consists of the characters 0-9.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the merchant's account that will process this transaction.
Data is a string that consists of the characters 0-9.
Boolean
OPTIONAL
An indicator that specifies if the Control Number will be provided by the Merchant during transaction processing.
The Control Number is used in forming the barcode on the Boleto.
JSON boolean values 'true' or 'false'.
Digits
REQUIRED
The number issued by Citi that uniquely identifies the type of transaction associated with merchant.
Data is a string that consists of the characters 0-9.
Details regarding an BQL_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
PT.
Bank Rakyat Indonesia (Persero) Tbk. via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding the acquirer link configuration for account to account browser payments.
Alphanumeric + additional characters
OPTIONAL
The name of the bank account holder for the beneficiary's bank account.
Required only for account to account browser payments.
Data may consist of the characters 0-9, a-z, A-Z, ' '
Alphanumeric
OPTIONAL
The beneficiary's Bank Account Number.
Required only for account to account browser payments.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
The international Business Identifier Code (BIC) for the beneficiary's bank account.
Required only for account to account browser payments.
Data may consist of the characters 0-9, a-z, A-Z
Regex
OPTIONAL
The International Bank Account Number (IBAN) for the beneficiary's bank account.
Required only for account to account browser payments.
Data must match regex
Details regarding a CAP acquirer link configuration.
String
OPTIONAL
The Store Id is an identifier allocated to the merchant by CAP as part of on boarding process.
Data can consist of any characters
Details regarding an CBA_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a CIC acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Alphanumeric
OPTIONAL
Provider key (Key) required to access the processing system.
The merchant receives this information when they set up an account with CIC.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider password (Passphrase) required to access the processing system.
The merchant receives this information when they set up an account with CIC
Data may consist of the characters 0-9, a-z, A-Z
Details regarding a Cielo acquirer link configuration.
Alphanumeric
OPTIONAL
Provider key (chave) required to access the processing system.
The merchant receives this information when they set up an account with Cielo.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding Citibank Private Label Card acquirer link configuration.
String
REQUIRED
The Partner ID issued to the merchant by Citibank.
The Partner ID identifies a group of merchant profiles within the Citibank system that belongs to the same merchant. This means that the same Partner ID can be assigned to more than one Citibank Merchant ID, i.e. to more than one merchant profile in the gateway (field merchant.acquirerLink.bankMerchantId).
Data can consist of any characters
Details regarding an DBS_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an DINERS_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an E-Global acquirer link configuration.
Digits
OPTIONAL
The acquirer is responsible for registering the merchant with Mastercard to allow the merchant to act as an aggregator.
Mastercard will issue the merchant with a Payment Facilitator ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be up to 7 characters long, and combined with the sub-merchant name must not exceed 21 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Digits
OPTIONAL
The acquirer is responsible for registering the merchant with Visa to allow the merchant to act as an aggregator.
Visa will issue the merchant with a Payment Facilitator ID. This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9.
Details regarding a eps-Überweisung acquirer link configuration.
Comma separated strings
OPTIONAL
List of supported payer bank countries for this merchant acquirer link.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding a Giropay acquirer link configuration.
Digits
OPTIONAL
The merchant is issued an Acquirer Merchant ID when they sign up with a giropay acquirer.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant is issued an External Merchant ID when they sign up with a giropay acquirer.
Data can consist of any characters
String
OPTIONAL
The merchant is issued an External Merchant Tag when they sign up with a giropay acquirer.
Data can consist of any characters
Digits
OPTIONAL
Bank account number of the merchant's bank account.
The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Bank identifier of the merchant's bank account.
Must be 8 digits. Add leading zeros if required. The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Bank account holder name of the merchant's bank account.
The customer will transfer the money into this bank account.
Data can consist of any characters
Details regarding a Global Payments East acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Details regarding a GWS acquirer link configuration.
String
OPTIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be up to 12 characters long and combined with the sub-merchant name must not exceed 37 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The country location of the merchant.
The value must be a three-letter country code according to ISO 3166-1 alpha-3.
Data must consist of the characters A-Z
Details regarding an HSBC_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an HSBCMYH_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding the acquirer link configuration for the Klarna Pay Later acquirer.
Comma separated strings
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding the acquirer link configuration for the Klarna Pay Now acquirer.
Comma separated strings
OPTIONAL
The list of supported payer bank countries for this merchant acquirer link.
Provide a list of three-letter country codes according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Mashreq Bank via MAA
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an NAB_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding the acquirer link configuration for the Open Banking Bank Transfer payment method for domestic UK payments
String
REQUIRED
The name on the merchant's bank account.
Data can consist of any characters
String
REQUIRED
The merchant's domestic bank account number.
Data can consist of any characters
String
REQUIRED
The domestic identifier for the merchant's bank, i.e. the sort code
Data can consist of any characters
Details regarding the acquirer link configuration for the Open Banking Bank Transfer payment method for domestic SEPA payments.
String
REQUIRED
The name on the merchant's bank account.
Data can consist of any characters
Alphanumeric
REQUIRED
The international identifier for the merchant's bank, i.e. the BIC.
Data may consist of the characters 0-9, a-z, A-Z
Regex
REQUIRED
The merchant's international bank account number (IBAN).
Data must match regex
Details regarding a PayU acquirer link configuration.
Comma separated strings
OPTIONAL
List of supported payer bank countries for this merchant acquirer link.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding the acquirer link configuration for the Payconiq acquirer.
Comma separated strings
OPTIONAL
The list of supported payer's account countries for this merchant acquirer link.
Provide a list of three-letter country codes according to ISO 3166-1 alpha-3.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding a Paymenttech Tampa acquirer link configuration.
Digits
OPTIONAL
Sent to the acquirer in authorization, authorization reversals, sysreversals and batch settlement requests.
Data is a string that consists of the characters 0-9.
Details regarding a PayPal acquirer link configuration.
Email
OPTIONAL
The email address of the merchant's PayPal business account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Email
OPTIONAL
The email address of the merchant's PayPal Sandbox account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Details regarding a paysafecard acquirer link configuration.
Comma separated strings
OPTIONAL
List of supported payer bank countries for this merchant acquirer link.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding a PPro acquirer link configuration.
String
OPTIONAL
The merchant's contract identifier.
The merchant is issued with this contract ID when they sign up with PPRO.
Data can consist of any characters
Details regarding a Redecard acquirer link configuration.
Alphanumeric
OPTIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding an S2I acquirer link configuration.
Decimal
OPTIONAL
Provide the Independent Sales Organization (ISO) ID of the ISO that the merchant is associated with.The ISO ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The acquirer is responsible for registering a Marketplace merchant with Visa.
Visa will issue the merchant with a Marketplace ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The acquirer is responsible for registering a merchant that wants to act as a Payment Facilitator with Mastercard.
Mastercard will issue the merchant with a Payment Facilitator ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
When submitting a transaction on behalf of a sub-merchants, this name may be displayed on the payer's cardholder statement (together with the sub-merchant name).
It may be 3, 7 or 12 characters long and combined with the sub-merchant name (as provided on the transaction request) must not exceed 21 characters. Use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Decimal
OPTIONAL
The acquirer is responsible for registering a merchant that wants to act as a Payment Facilitator with Visa.
Visa will issue the merchant with a Payment Facilitator ID.This ID will be submitted to the acquirer with every transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Information about the merchant held with the Service Provider.
String
OPTIONAL
The unique identifier for the merchant with the Service Provider.
Data can consist of any characters
Details regarding the acquirer link configuration for the Sofort acquirer.
Comma separated strings
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding a Sofortbanking acquirer link configuration.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The notification password must be the same as the one in the merchants Sofortbanking account and is used by to generate a hash value that is used to securely identify the messages received from Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a Project ID (Projektnummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The project password must be the same as the one in the merchants Sofortbanking account and is used to generate a hash value that is used to securely identify the messages sent to Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a user ID (Kundennummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
Details regarding an SUNCORP_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding a Trustly acquirer link configuration.
Comma separated strings
OPTIONAL
List of supported payer bank countries for this merchant acquirer link.
Each String represents an ISO 3166-1 alpha-3 code for the country.
Details regarding a TSYS acquirer link configuration.
String
OPTIONAL
Identifies the institution that signs the merchant.
Data can consist of any characters
String
OPTIONAL
The merchant chain identification number.
Data can consist of any characters
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Identifies a specific merchant store within the TSYS Acquiring Solutions' system.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Processor specific time zone differential.
Data can consist of any characters
String
OPTIONAL
The merchant assigned Terminal ID Number.
Data can consist of any characters
Details regarding a Vantiv acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Details regarding an VCB_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an WBC_NZ_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding an WBCS2I_MAA acquirer link configuration.
String
OPTIONAL
The password used to communicate with the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS production profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The access code is an identifier that is used to authenticate the merchant for API transactions.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's production profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
The Shared Secret is used to prevent a cardholder from tampering with the transaction details.
Data can consist of any characters
String
OPTIONAL
The password used to communicate with the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The user name used to connect to the MIGS test profile.
Data can consist of any characters
String
OPTIONAL
The Access Code for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
String
OPTIONAL
The Shared Secret for the merchant's test profile in MIGS Merchant Administration -> Admin -> Configuration Details page.
Data can consist of any characters
Details regarding WorldPay CompanyId acquirer link configuration.
Digits
REQUIRED
Provide the Company ID assigned to the merchant by WorldPay.
The Company ID is numeric and between 6 and 13 digits.
Data is a string that consists of the characters 0-9.
String
REQUIRED
The unique identifier for the acquirer issued by the gateway.
Please contact ANZ Worldline Payment Solutions for a list of supported acquirers and their ID.
Data can consist of any characters
Configuration required for the merchant to perform payer authentication, including 3DS authentication and ITMX LSS.
Configuration required for the merchant to perform 3-D Secure payer authentication using American Express SafeKey, including 3-D Secure version 1 and 3-D Secure version 2.
Digits
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to American Express SafeKey version 1 and version 2.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use American Express SafeKey version 1.
Data can consist of any characters
Configuration required for the merchant to perform 3-D Secure payer authentication using Discover ProtectBuy.
Configuration specific for payer authentication using 3-D Secure version 1.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use Discover ProtectBuy version 1.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
Merchant ID assigned to the merchant by the acquirer that has registered the merchant for payer authentication using Discover ProtectBuy 2.0.
If provided, this value will override the Bank Merchant ID/SE Number configured on the merchant acquirer link in messages submitted to Discover ProtectBuy
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Digits
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to Discover ProtectBuy.
Data is a string that consists of the characters 0-9.
Configuration required to perform payer authentication using ITMX LSS Authentication.
Alphanumeric + additional characters
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use ITMX LSS EMV 3DS Authentication.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Configuration required for the merchant to perform 3-D Secure payer authentication using J/Secure.
Configuration specific for payer authentication using 3-D Secure version 1.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use JCB J/Secure version 1.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use JCB J/Secure version 1.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
Merchant ID assigned to the merchant by the acquirer that has registered the merchant for payer authentication using JCB J/Secure 2.0.
If provided, this value will override the Bank Merchant ID/SE Number configured on the merchant acquirer link in messages submitted to JCB JSecure.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Digits
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to JCB JSecure.
Data is a string that consists of the characters 0-9.
Configuration required for the merchant to perform 3-D Secure payer authentication using Mastercard
Configuration specific for payer authentication using 3-D Secure version 1.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use MasterCard SecureCode version 1.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use MasterCard SecureCode version 1.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
Merchant ID assigned to the merchant by the acquirer that has registered the merchant for payer authentication using Mastercard SecureCode version 2.
If provided, this value will override the Bank Merchant ID/SE Number configured on the merchant acquirer link in messages submitted to Mastercard SecureCode.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Digits
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to Mastercard SecureCode version 1 and 2.
Data is a string that consists of the characters 0-9.
Configuration required for the merchant to perform 3-D Secure payer authentication using UnionPay 3-D Secure.
Alphanumeric
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to UnionPay 3-D Secure.
Data may consist of the characters 0-9, a-z, A-Z
ASCII Text
OPTIONAL
Merchant ID assigned to the merchant by the acquirer that has registered the merchant for payer authentication using UnionPay 3-D Secure.
If provided, this value will override the Bank Merchant ID/SE Number configured on the merchant acquirer link in messages submitted to UnionPay 3-D Secure.
Data consists of ASCII characters
Configuration required for the merchant to perform 3-D Secure payer authentication using Verified by Visa, including 3-D Secure version 1 and 3-D Secure version 2.
Configuration specific for payer authentication using 3-D Secure version 1.
String
OPTIONAL
Card Acceptor ID provided to the merchant by their acquirer when they registered to use Verified by Visa version 1.
Data can consist of any characters
String
OPTIONAL
Card Acceptor Terminal ID provided to the merchant by their acquirer when they registered to use Verified by Visa version 1.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use Verified by Visa version 1.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
Merchant ID assigned to the merchant by the acquirer that has registered the merchant for payer authentication using Verified by Visa version 2.
If provided, this value will override the Bank Merchant ID/SE Number configured on the merchant acquirer link in messages submitted to Verified by Visa version 2.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Digits
OPTIONAL
If provided, this value will override the Acquirer BIN configured for this acquirer in the gateway.
As a result the gateway will use this Acquirer BIN to identify the acquirer in messages submitted to Verified by Visa version 1 and version 2.
Data is a string that consists of the characters 0-9.
Details about the browser payments supported by the acquirer.
String
OPTIONAL
The type of browser payment supported by the acquirer.
This field must be provided if merchant.acquirerLink.{id}.paymentType=BROWSER_PAYMENT. See Browser Payments for details.
Data can consist of any characters
JSON Text
OPTIONAL
This field triggers custom processing.
MasterCard will inform you if this is applicable to your merchants.
Data is valid Json Format
Details regarding payment plans supported for this merchant acquirer link.
Note that not all fields in this parameter group will be applicable to the configuration of all payment plans. Please refer to the Online Integration Guide for details about supported payment plans.
Integer
OPTIONAL
A limitation on the number of periods for which the first payment can be deferred.
The payer will be offered either no deferrals, or this number of deferrals.
Operations attempting to set a value that is not supported by the plan will be rejected. Please refer to the Online Integration Guide for the supported values for each payment plan.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
Integer
OPTIONAL
The maximum number of installments that will be offered to payers using this payment plan.
The payer will be offered all values that are supported by the plan, up to and including this value.
Operations attempting to set a value that is not supported by the plan will be rejected. Please refer to the Online Integration Guide for the supported values for each payment plan.
JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.
A minimum order value for which the payment plan will be offered.
A payer is offered this plan if their order is:
- • in a supported currency, and
- • has an amount equal or greater than the minimum amount for that currency.
The default value is an empty list.
Decimal
OPTIONAL
A minimum order amount for which the payment plan will be offered.
Data is a decimal number.
Upper case alphabetic text
OPTIONAL
The currency of the minimum order amount expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
OPTIONAL
The ID of the payment plan you want to enable for the merchant acquirer link (e.g. PlanN).
Please refer to the Online Integration Guide for the payment plans supported and their IDs.
Data can consist of any characters
String
OPTIONAL
The administrative password for the merchant.
Data can consist of any characters
Response
Fields
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
Errors
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.